Submerchants

Retrieve Sub Merchants

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Sub Merchants

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/sub_merchants?from=&to=&offset=&limit=&order="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubMerchantsApi;

import java.io.File;
import java.util.*;

public class SubMerchantsApiExample {

    public static void main(String[] args) {
        
        SubMerchantsApi apiInstance = new SubMerchantsApi();
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | 
        Integer limit = 56; // Integer | 
        String order = order_example; // String | 
        try {
            list result = apiInstance.subMerchantsGet(from, to, offset, limit, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubMerchantsApi#subMerchantsGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubMerchantsApi;

public class SubMerchantsApiExample {

    public static void main(String[] args) {
        SubMerchantsApi apiInstance = new SubMerchantsApi();
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | 
        Integer limit = 56; // Integer | 
        String order = order_example; // String | 
        try {
            list result = apiInstance.subMerchantsGet(from, to, offset, limit, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubMerchantsApi#subMerchantsGet");
            e.printStackTrace();
        }
    }
}

Date *from = 2013-10-20T19:20:30+01:00; //  (optional) (default to 1970-01-01T00:00Z)
Date *to = 2013-10-20T19:20:30+01:00; //  (optional)
Integer *offset = 56; //  (optional) (default to 0)
Integer *limit = 56; //  (optional) (default to 20)
String *order = order_example; //  (optional) (default to chronological)

SubMerchantsApi *apiInstance = [[SubMerchantsApi alloc] init];

[apiInstance subMerchantsGetWith:from
    to:to
    offset:offset
    limit:limit
    order:order
              completionHandler: ^(list output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.SubMerchantsApi()
var opts = { 
  'from': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'to': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'offset': 56, // {{Integer}} 
  'limit': 56, // {{Integer}} 
  'order': order_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subMerchantsGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subMerchantsGetExample
    {
        public void main()
        {

            var apiInstance = new SubMerchantsApi();
            var from = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to 1970-01-01T00:00Z)
            var to = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var limit = 56;  // Integer |  (optional)  (default to 20)
            var order = order_example;  // String |  (optional)  (default to chronological)

            try
            {
                list result = apiInstance.subMerchantsGet(from, to, offset, limit, order);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubMerchantsApi.subMerchantsGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSubMerchantsApi();
$from = 2013-10-20T19:20:30+01:00; // Date | 
$to = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | 
$limit = 56; // Integer | 
$order = order_example; // String | 

try {
    $result = $api_instance->subMerchantsGet($from, $to, $offset, $limit, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubMerchantsApi->subMerchantsGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubMerchantsApi;

my $api_instance = WWW::SwaggerClient::SubMerchantsApi->new();
my $from = 2013-10-20T19:20:30+01:00; # Date | 
my $to = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | 
my $limit = 56; # Integer | 
my $order = order_example; # String | 

eval { 
    my $result = $api_instance->subMerchantsGet(from => $from, to => $to, offset => $offset, limit => $limit, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubMerchantsApi->subMerchantsGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SubMerchantsApi()
from = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to 1970-01-01T00:00Z)
to = 2013-10-20T19:20:30+01:00 # Date |  (optional)
offset = 56 # Integer |  (optional) (default to 0)
limit = 56 # Integer |  (optional) (default to 20)
order = order_example # String |  (optional) (default to chronological)

try: 
    api_response = api_instance.sub_merchants_get(from=from, to=to, offset=offset, limit=limit, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubMerchantsApi->subMerchantsGet: %s\n" % e)

Parameters

Name	Description
from	Date (date-time)
to	Date (date-time)
offset	Integer
limit	Integer
order	String

Create Sub Merchants

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Sub Merchants

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://api.omise.co/sub_merchants"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubMerchantsApi;

import java.io.File;
import java.util.*;

public class SubMerchantsApiExample {

    public static void main(String[] args) {
        
        SubMerchantsApi apiInstance = new SubMerchantsApi();
        String name = name_example; // String | 
        try {
            sub_merchant result = apiInstance.subMerchantsPost(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubMerchantsApi#subMerchantsPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubMerchantsApi;

public class SubMerchantsApiExample {

    public static void main(String[] args) {
        SubMerchantsApi apiInstance = new SubMerchantsApi();
        String name = name_example; // String | 
        try {
            sub_merchant result = apiInstance.subMerchantsPost(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubMerchantsApi#subMerchantsPost");
            e.printStackTrace();
        }
    }
}

String *name = name_example; //  (optional)

SubMerchantsApi *apiInstance = [[SubMerchantsApi alloc] init];

[apiInstance subMerchantsPostWith:name
              completionHandler: ^(sub_merchant output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.SubMerchantsApi()
var opts = { 
  'name': name_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subMerchantsPost(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subMerchantsPostExample
    {
        public void main()
        {

            var apiInstance = new SubMerchantsApi();
            var name = name_example;  // String |  (optional) 

            try
            {
                sub_merchant result = apiInstance.subMerchantsPost(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubMerchantsApi.subMerchantsPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSubMerchantsApi();
$name = name_example; // String | 

try {
    $result = $api_instance->subMerchantsPost($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubMerchantsApi->subMerchantsPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubMerchantsApi;

my $api_instance = WWW::SwaggerClient::SubMerchantsApi->new();
my $name = name_example; # String | 

eval { 
    my $result = $api_instance->subMerchantsPost(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubMerchantsApi->subMerchantsPost: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SubMerchantsApi()
name = name_example # String |  (optional)

try: 
    api_response = api_instance.sub_merchants_post(name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubMerchantsApi->subMerchantsPost: %s\n" % e)

Parameters

Name	Description
name	String

Retrieve Sub Merchants Search

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Sub Merchants Search

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/sub_merchants/search?scope=&query=&filters[agreement_accepted]=&filters[created]=&filters[live_activated]=&filters[owner_uid]=&filters[registration_status]="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubMerchantsApi;

import java.io.File;
import java.util.*;

public class SubMerchantsApiExample {

    public static void main(String[] args) {
        
        SubMerchantsApi apiInstance = new SubMerchantsApi();
        String scope = scope_example; // String | 
        String query = query_example; // String | 
        Integer filters[agreementAccepted] = 56; // Integer | 
        Date filters[created] = 2013-10-20T19:20:30+01:00; // Date | 
        Boolean filters[liveActivated] = true; // Boolean | 
        String filters[ownerUid] = filters[ownerUid]_example; // String | 
        String filters[registrationStatus] = filters[registrationStatus]_example; // String | 
        try {
            sub_merchant result = apiInstance.subMerchantsSearchGet(scope, query, filters[agreementAccepted], filters[created], filters[liveActivated], filters[ownerUid], filters[registrationStatus]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubMerchantsApi#subMerchantsSearchGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubMerchantsApi;

public class SubMerchantsApiExample {

    public static void main(String[] args) {
        SubMerchantsApi apiInstance = new SubMerchantsApi();
        String scope = scope_example; // String | 
        String query = query_example; // String | 
        Integer filters[agreementAccepted] = 56; // Integer | 
        Date filters[created] = 2013-10-20T19:20:30+01:00; // Date | 
        Boolean filters[liveActivated] = true; // Boolean | 
        String filters[ownerUid] = filters[ownerUid]_example; // String | 
        String filters[registrationStatus] = filters[registrationStatus]_example; // String | 
        try {
            sub_merchant result = apiInstance.subMerchantsSearchGet(scope, query, filters[agreementAccepted], filters[created], filters[liveActivated], filters[ownerUid], filters[registrationStatus]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubMerchantsApi#subMerchantsSearchGet");
            e.printStackTrace();
        }
    }
}

String *scope = scope_example; //  (optional) (default to sub_merchant)
String *query = query_example; //  (optional)
Integer *filters[agreementAccepted] = 56; //  (optional)
Date *filters[created] = 2013-10-20T19:20:30+01:00; //  (optional)
Boolean *filters[liveActivated] = true; //  (optional)
String *filters[ownerUid] = filters[ownerUid]_example; //  (optional)
String *filters[registrationStatus] = filters[registrationStatus]_example; //  (optional)

SubMerchantsApi *apiInstance = [[SubMerchantsApi alloc] init];

[apiInstance subMerchantsSearchGetWith:scope
    query:query
    filters[agreementAccepted]:filters[agreementAccepted]
    filters[created]:filters[created]
    filters[liveActivated]:filters[liveActivated]
    filters[ownerUid]:filters[ownerUid]
    filters[registrationStatus]:filters[registrationStatus]
              completionHandler: ^(sub_merchant output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.SubMerchantsApi()
var opts = { 
  'scope': scope_example, // {{String}} 
  'query': query_example, // {{String}} 
  'filters[agreementAccepted]': 56, // {{Integer}} 
  'filters[created]': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'filters[liveActivated]': true, // {{Boolean}} 
  'filters[ownerUid]': filters[ownerUid]_example, // {{String}} 
  'filters[registrationStatus]': filters[registrationStatus]_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subMerchantsSearchGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subMerchantsSearchGetExample
    {
        public void main()
        {

            var apiInstance = new SubMerchantsApi();
            var scope = scope_example;  // String |  (optional)  (default to sub_merchant)
            var query = query_example;  // String |  (optional) 
            var filters[agreementAccepted] = 56;  // Integer |  (optional) 
            var filters[created] = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var filters[liveActivated] = true;  // Boolean |  (optional) 
            var filters[ownerUid] = filters[ownerUid]_example;  // String |  (optional) 
            var filters[registrationStatus] = filters[registrationStatus]_example;  // String |  (optional) 

            try
            {
                sub_merchant result = apiInstance.subMerchantsSearchGet(scope, query, filters[agreementAccepted], filters[created], filters[liveActivated], filters[ownerUid], filters[registrationStatus]);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubMerchantsApi.subMerchantsSearchGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSubMerchantsApi();
$scope = scope_example; // String | 
$query = query_example; // String | 
$filters[agreementAccepted] = 56; // Integer | 
$filters[created] = 2013-10-20T19:20:30+01:00; // Date | 
$filters[liveActivated] = true; // Boolean | 
$filters[ownerUid] = filters[ownerUid]_example; // String | 
$filters[registrationStatus] = filters[registrationStatus]_example; // String | 

try {
    $result = $api_instance->subMerchantsSearchGet($scope, $query, $filters[agreementAccepted], $filters[created], $filters[liveActivated], $filters[ownerUid], $filters[registrationStatus]);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubMerchantsApi->subMerchantsSearchGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubMerchantsApi;

my $api_instance = WWW::SwaggerClient::SubMerchantsApi->new();
my $scope = scope_example; # String | 
my $query = query_example; # String | 
my $filters[agreementAccepted] = 56; # Integer | 
my $filters[created] = 2013-10-20T19:20:30+01:00; # Date | 
my $filters[liveActivated] = true; # Boolean | 
my $filters[ownerUid] = filters[ownerUid]_example; # String | 
my $filters[registrationStatus] = filters[registrationStatus]_example; # String | 

eval { 
    my $result = $api_instance->subMerchantsSearchGet(scope => $scope, query => $query, filters[agreementAccepted] => $filters[agreementAccepted], filters[created] => $filters[created], filters[liveActivated] => $filters[liveActivated], filters[ownerUid] => $filters[ownerUid], filters[registrationStatus] => $filters[registrationStatus]);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubMerchantsApi->subMerchantsSearchGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SubMerchantsApi()
scope = scope_example # String |  (optional) (default to sub_merchant)
query = query_example # String |  (optional)
filters[agreementAccepted] = 56 # Integer |  (optional)
filters[created] = 2013-10-20T19:20:30+01:00 # Date |  (optional)
filters[liveActivated] = true # Boolean |  (optional)
filters[ownerUid] = filters[ownerUid]_example # String |  (optional)
filters[registrationStatus] = filters[registrationStatus]_example # String |  (optional)

try: 
    api_response = api_instance.sub_merchants_search_get(scope=scope, query=query, filters[agreementAccepted]=filters[agreementAccepted], filters[created]=filters[created], filters[liveActivated]=filters[liveActivated], filters[ownerUid]=filters[ownerUid], filters[registrationStatus]=filters[registrationStatus])
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubMerchantsApi->subMerchantsSearchGet: %s\n" % e)

Parameters

Name	Description
scope	String
query	String
filters[agreement_accepted]	Integer
filters[created]	Date (date-time)
filters[live_activated]	Boolean
filters[owner_uid]	String
filters[registration_status]	String

Responses

Status: 200

 {
  "object": {
    "pattern": "sub_merchant",
    "type": "string",
    "default": "sub_merchant"
  },
  "id": {
    "type": "string"
  },
  "name": {
    "type": "string"
  },
  "live_account_status": {
    "type": "string",
    "enum": [
      "unsubmitted",
      "start",
      "pending",
      "accepted",
      "rejected"
    ]
  },
  "live_account_registration_id": {
    "type": "string"
  },
  "default_mid": {
    "type": "string"
  },
  "parent_team_id": {
    "type": "string"
  },
  "direct_children_count": {
    "type": "integer"
  },
  "created_at": {
    "type": "string",
    "format": "date-time"
  },
  "level": {
    "type": "integer"
  }
}